home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / infoclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  3.8 KB  |  160 lines
  1. TABLE OF CONTENTS
  2.  
  3. infoclass/--background--
  4. infoclass/INFO_Args
  5. infoclass/INFO_FixTextWidth
  6. infoclass/INFO_MinLines
  7. infoclass/INFO_TextFormat
  8. infoclass/INFO_[xxx]Offset
  9.  
  10. infoclass/--background--
  11.  
  12.     NAME
  13.     Class:        infoclass
  14.     Superclass:    baseclass
  15.     Include File:    <libraries/bgui.h>
  16.  
  17.     FUNCTION
  18.     To  provide  a    general  multi-line  text gadget which can be used for
  19.     on-line  help  or  general information purposes. It has the ability to
  20.     handle    different  text  style,  colors  and text justifications. Also
  21.     C-style formatting codes are allowed.
  22.  
  23.     A  good  example  of  the  usage  of this class is the BGUI_RequestA()
  24.     routine.  This    routine  uses  an infoclass object to display the body
  25.     text.
  26.  
  27.     This gadget does not send out notification events.
  28.  
  29. infoclass/INFO_Args
  30.  
  31.     NAME
  32.     INFO_Args -- ( ULONG * )
  33.  
  34.     FUNCTION
  35.     Set  the arguments accoording to the C-style formatting codes found in
  36.     the text.
  37.  
  38.     DEFAULT
  39.     NULL.
  40.  
  41.     APPLICABILITY
  42.     (ISU).
  43.  
  44.     SEE ALSO
  45.     exec.library/RawDoFmt(), INFO_TextFormat
  46.  
  47. infoclass/INFO_FixTextWidth
  48.  
  49.     NAME
  50.     INFO_FixTextWidth -- ( BOOL )
  51.  
  52.     FUNCTION
  53.     To tell the object that it's minimum width may not be smaller than the
  54.     width  of  the    longest  line  in the text plus the offsets and border
  55.     thickness.
  56.  
  57.     DEFAULT
  58.     FALSE.
  59.  
  60.     APPLICABILITY
  61.     (I).
  62.  
  63.     SEE ALSO
  64.     INFO_HorizOffset, INFO_VertOffset, INFO_MinLines
  65.  
  66. infoclass/INFO_MinLines
  67.  
  68.     NAME
  69.     INFO_MinLines -- ( ULONG )
  70.  
  71.     FUNCTION
  72.     Set  the  minimum  number  of  lines  the object should display at all
  73.     times.    This  is  taken into consideration when to object it's minimum
  74.     size is calculated.
  75.  
  76.     DEFAULT
  77.     1.
  78.  
  79.     APPLICABILITY
  80.     (I).
  81.  
  82.     SEE ALSO
  83.     INFO_FixTextWidth
  84.  
  85. infoclass/INFO_TextFormat
  86.  
  87.     NAME
  88.     INFO_TextFormat -- ( STRPTR )
  89.  
  90.     FUNCTION
  91.     Set  the  textual  contents  of the gadget object. You can use C-style
  92.     formatting  codes in the text and in addition to that you may also use
  93.     any of the following command sequences:
  94.  
  95.     STYLE OPTIONS
  96.     \33b    - Bold text on.            \33-b    - Bold text off.
  97.     \33i    - Italic text on.        \33-i    - Italic text off.
  98.     \33u    - Underlined text on.        \33-u    - Underlined text off.
  99.     \33s    - Shadowed text on.        \33-s    - Shadowed text off.
  100.     \33n    - Normal text.
  101.  
  102.     JUSTIFICATION OPTIONS
  103.     \33c    - Center this and the following lines.
  104.     \33l    - Left-justify this and the following lines.
  105.     \33r    - Right-justify this and the following lines.
  106.  
  107.     The \33c, \33l and \33r command sequences can only be used at the
  108.     beginning of a new line.
  109.  
  110.     PEN OPTIONS
  111.     \33p[n]    - Set pen [n].            \33P[n] - Set back pen [n].
  112.     \33d[n]    - Set dri pen [n].        \33D[n] - Set back dripen [n].
  113.  
  114.     MISCELLANEOUS
  115.     \n    - Start a new line of text.
  116.     \33k  - Keep color and formatting changes between lines.
  117.     \33w  - Make text wrap if when it is too large to fit.
  118.     \331  - Make text be rendered in JAM1 mode.
  119.     \332  - Make text be rendered in JAM2 mode.
  120.     \33C  - Make text be rendered in COMPLEMENT mode.
  121.     \33z    - Label lined text on.        \33-z    - Label lined text off.
  122.     \33Z    - Label highlined text on.    \33-Z    - Label highlined text off.
  123.     
  124.     The \33z and \33-z attributes are used by the labelclass for underlining
  125.     key equivalents specified with the underscore character.  Use these if
  126.     you want to indicate a key equivalent longer than one character.  The
  127.     \33Z and \33-Z attributes will render the underline in the SHINEPEN.
  128.  
  129.     Since V38 of the library it is possible to use locale's FormatString()
  130.     formatting  codes.  Locale specific formatting codes will only work
  131.     when the locale.library is available.
  132.  
  133.     DEFAULT
  134.     NULL.
  135.  
  136.     APPLICABILITY
  137.     (ISU).
  138.  
  139.     SEE ALSO
  140.     <intuition/screens.h>, exec.library/RawDoFmt(), INFO_Args
  141.  
  142. infoclass/INFO_[xxx]Offset
  143.  
  144.     NAME
  145.     INFO_HorizOffset, INFO_VertOffset -- ( ULONG )
  146.  
  147.     FUNCTION
  148.     Set  the  horizontal  and  vertical  offset from the object borders at
  149.     which the text is rendered.
  150.  
  151.     DEFAULTS
  152.     8 horizontally and 6 vertically.
  153.  
  154.     APPLICABILITY
  155.     (I).
  156.  
  157.     SEE ALSO
  158.     INFO_FixTextWidth
  159.  
  160.